Documentation Powered by ReDoc

JamApi (0.1.1)

Download OpenAPI specification:Download

License: MIT

Api for JamServe

Authentication

cookieAuth

Security scheme type: API Key
cookie parameter name: jam.sid

bearerAuth

Security scheme type: HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

various

ping

is the api online?

Responses

200

ok

get /ping
A local JamServe API
http://localhost:4040/api/v1/ping

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "version": "string"
}

autocompleteController.autocomplete

autocomplete

Authorizations:
cookieAuthbearerAuth
query Parameters
query
required
string

query to complete

track
integer >= 0
Default: 0

amount of track names to complete

artist
integer >= 0
Default: 0

amount of artist names to complete

album
integer >= 0
Default: 0

amount of album names to complete

folder
integer >= 0
Default: 0

amount of folder names to complete

playlist
integer >= 0
Default: 0

amount of playlist names to complete

podcast
integer >= 0
Default: 0

amount of podcast names to complete

episode
integer >= 0
Default: 0

amount of episode names to complete

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /autocomplete
A local JamServe API
http://localhost:4040/api/v1/autocomplete

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "tracks":
    [
    ],
  • "artists":
    [
    ],
  • "albums":
    [
    ],
  • "folders":
    [
    ],
  • "playlists":
    [
    ],
  • "podcasts":
    [
    ],
  • "episodes":
    [
    ]
}

genreController.list

get list of genres found in the library

Authorizations:
cookieAuthbearerAuth
query Parameters
rootID
string

filter by root id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /genre/list
A local JamServe API
http://localhost:4040/api/v1/genre/list

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

statsController.get

get count stats for folders/tracks/albums/...

Authorizations:
cookieAuthbearerAuth
query Parameters
rootID
string

filter by root id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /stats
A local JamServe API
http://localhost:4040/api/v1/stats

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "rootID": "string",
  • "track": 0,
  • "folder": 0,
  • "artist": 0,
  • "artistTypes":
    {
    },
  • "album": 0,
  • "albumTypes":
    {
    }
}

nowPlayingController.list

get list of tracks played by all users

Authorizations:
cookieAuthbearerAuth

Responses

200

ok

401

unauthorized

500

internal server error

get /nowPlaying/list
A local JamServe API
http://localhost:4040/api/v1/nowPlaying/list

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

auth

session

check the login state

Responses

200

ok

get /session
A local JamServe API
http://localhost:4040/api/v1/session

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "version": "string",
  • "user":
    {
    },
  • "jwt": "string",
  • "allowedCookieDomains":
    [
    ]
}

login

login an user

Request Body schema: application/json
username
required
string

user name

password
required
string

password

client
required
string

client name

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

post /login
A local JamServe API
http://localhost:4040/api/v1/login

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "username": "string",
  • "password": "string",
  • "client": "string"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "version": "string",
  • "user":
    {
    },
  • "jwt": "string",
  • "allowedCookieDomains":
    [
    ]
}

logout

logout an user

Authorizations:
cookieAuthbearerAuth

Responses

200

ok

401

unauthorized

500

internal server error

post /logout
A local JamServe API
http://localhost:4040/api/v1/logout

metadata

metadataController.lastfmLookup

lookup lastfm data

Authorizations:
cookieAuthbearerAuth
query Parameters
type
required
string (JamParameters.LastFMLookupType)
Enum:"album" "album-toptracks" "artist" "artist-toptracks" "track" "track-similar"

lookup by lastfm type

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /lastfm/lookup
A local JamServe API
http://localhost:4040/api/v1/lastfm/lookup

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "similartracks":
    {
    },
  • "toptracks":
    {
    },
  • "artist":
    {
    },
  • "album":
    {
    },
  • "track":
    {
    }
}

metadataController.acoustidLookup

lookup acoustid data

Authorizations:
cookieAuthbearerAuth
query Parameters
inc
string

comma-separated acoustid includes

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /acoustid/lookup
A local JamServe API
http://localhost:4040/api/v1/acoustid/lookup

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

metadataController.musicbrainzLookup

lookup musicbrainz data

Authorizations:
cookieAuthbearerAuth
query Parameters
type
required
string (JamParameters.MusicBrainzLookupType)
Enum:"area" "artist" "collection" "event" "instrument" "label" "place" "recording" "release" "release-group" "series" "url" "work"

lookup by musicbrainz type

inc
string

comma-separated musicbrainz includes

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /musicbrainz/lookup
A local JamServe API
http://localhost:4040/api/v1/musicbrainz/lookup

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "artist":
    {
    },
  • "artists":
    [
    ],
  • "release":
    {
    },
  • "releases":
    [
    ],
  • "releaseGroup":
    {
    },
  • "releaseGroups":
    [
    ],
  • "recording":
    {
    },
  • "recordings":
    [
    ],
  • "count": 0,
  • "offset": 0,
  • "created": "string"
}

metadataController.musicbrainzSearch

search musicbrainz data

Authorizations:
cookieAuthbearerAuth
query Parameters
type
required
string (JamParameters.MusicBrainzSearchType)
Enum:"area" "artist" "label" "recording" "release" "release-group" "work"

search by musicbrainz type

recording
string

search by recording name

releasegroup
string

search by releasegroup name

release
string

search by release name

artist
string

search by artist name

tracks
integer

search by number of release tracks

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /musicbrainz/search
A local JamServe API
http://localhost:4040/api/v1/musicbrainz/search

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "artist":
    {
    },
  • "artists":
    [
    ],
  • "release":
    {
    },
  • "releases":
    [
    ],
  • "releaseGroup":
    {
    },
  • "releaseGroups":
    [
    ],
  • "recording":
    {
    },
  • "recordings":
    [
    ],
  • "count": 0,
  • "offset": 0,
  • "created": "string"
}

metadataController.acousticbrainzLookup

lookup acousticbrainz data

Authorizations:
cookieAuthbearerAuth
query Parameters
nr
number

page parameter if more than one acousticbrainz info is available

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /acousticbrainz/lookup
A local JamServe API
http://localhost:4040/api/v1/acousticbrainz/lookup

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "highlevel":
    {
    },
  • "metadata":
    {
    }
}

metadataController.coverartarchiveLookup

lookup coverartarchive data

Authorizations:
cookieAuthbearerAuth
query Parameters
type
required
string (JamParameters.CoverArtArchiveLookupType)
Enum:"release" "release-group"

lookup by musicbrainz type

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /coverartarchive/lookup
A local JamServe API
http://localhost:4040/api/v1/coverartarchive/lookup

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "images":
    [
    ],
  • "release": "string"
}

metadataController.wikipediaSummary

wikipedia summary

Authorizations:
cookieAuthbearerAuth
query Parameters
title
required
string

lookup by page title

lang
string
Default: "en"

wikipedia language

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /wikipedia/summary
A local JamServe API
http://localhost:4040/api/v1/wikipedia/summary

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "summary":
    {
    }
}

metadataController.wikidataSummary

wikipedia summary

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

lookup by wikidata id

lang
string
Default: "en"

get summary of wikipedia language

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /wikidata/summary
A local JamServe API
http://localhost:4040/api/v1/wikidata/summary

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "summary":
    {
    }
}

chat

chatController.list

get chat messages

Authorizations:
cookieAuthbearerAuth
query Parameters
since
integer >= 0

filter by post time (unix time)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /chat/list
A local JamServe API
http://localhost:4040/api/v1/chat/list

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

chatController.create

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
message
required
string

the chat message

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

post /chat/create
A local JamServe API
http://localhost:4040/api/v1/chat/create

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "message": "string"
}

chatController.delete

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
time
required
integer >= 0

time of the post (unix time)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /chat/delete
A local JamServe API
http://localhost:4040/api/v1/chat/delete

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "time": 0
}

folder

folderController.index

get the navigation index for folders

Authorizations:
cookieAuthbearerAuth
query Parameters
rootID
string

filter by root id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /folder/index
A local JamServe API
http://localhost:4040/api/v1/folder/index

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "lastModified": 0,
  • "groups":
    [
    ]
}

folderController.id

get a folder by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

folderTag
boolean
Default: false

include tag on folder(s)

folderState
boolean
Default: false

include user states (fav,rate) on folder(s)

folderCounts
boolean
Default: false

include information about children (trackCount/folderCount) on folder(s)

folderHealth
boolean
Default: false

include information about the meta data quality on folder(s)

folderParents
boolean
Default: false

include a list of all parent folder ids on folder(s)

folderInfo
boolean
Default: false

include extended meta data on folder(s)

folderSimilar
boolean
Default: false

include similar folders list on folder(s) - only for folders of type artist

folderArtworks
boolean
Default: false

include artwork images list on folder(s)

folderChildren
boolean
Default: false

include tracks and sub folders on folder(s)

folderSubfolders
boolean
Default: false

include sub folders on folder(s)

folderTracks
boolean
Default: false

include tracks on folder(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/id
A local JamServe API
http://localhost:4040/api/v1/folder/id

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "parentID": "string",
  • "level": 0,
  • "type": "album",
  • "trackCount": 0,
  • "folderCount": 0,
  • "tag":
    {
    },
  • "health":
    [
    ],
  • "info":
    {
    },
  • "folders":
    [
    ],
  • "tracks":
    [
    ],
  • "parents":
    [
    ],
  • "artworks":
    [
    ],
  • "similar":
    [
    ],
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

folderController.ids

get folders by ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

folderTag
boolean
Default: false

include tag on folder(s)

folderState
boolean
Default: false

include user states (fav,rate) on folder(s)

folderCounts
boolean
Default: false

include information about children (trackCount/folderCount) on folder(s)

folderHealth
boolean
Default: false

include information about the meta data quality on folder(s)

folderParents
boolean
Default: false

include a list of all parent folder ids on folder(s)

folderInfo
boolean
Default: false

include extended meta data on folder(s)

folderSimilar
boolean
Default: false

include similar folders list on folder(s) - only for folders of type artist

folderArtworks
boolean
Default: false

include artwork images list on folder(s)

folderChildren
boolean
Default: false

include tracks and sub folders on folder(s)

folderSubfolders
boolean
Default: false

include sub folders on folder(s)

folderTracks
boolean
Default: false

include tracks on folder(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /folder/ids
A local JamServe API
http://localhost:4040/api/v1/folder/ids

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

folderController.children

get tracks and subfolders of a folder by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

folderTag
boolean
Default: false

include tag on folder(s)

folderState
boolean
Default: false

include user states (fav,rate) on folder(s)

folderCounts
boolean
Default: false

include information about children (trackCount/folderCount) on folder(s)

folderHealth
boolean
Default: false

include information about the meta data quality on folder(s)

folderParents
boolean
Default: false

include a list of all parent folder ids on folder(s)

folderInfo
boolean
Default: false

include extended meta data on folder(s)

folderSimilar
boolean
Default: false

include similar folders list on folder(s) - only for folders of type artist

folderArtworks
boolean
Default: false

include artwork images list on folder(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/children
A local JamServe API
http://localhost:4040/api/v1/folder/children

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "folders":
    [
    ],
  • "tracks":
    [
    ]
}

folderController.tracks

get tracks of a folder by id

Authorizations:
cookieAuthbearerAuth
query Parameters
recursive
boolean
Default: false

include tracks of a sub folders

ids
required
Array of string

array of item ids

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/tracks
A local JamServe API
http://localhost:4040/api/v1/folder/tracks

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

folderController.subfolders

get sub folders of a folder by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

folderTag
boolean
Default: false

include tag on folder(s)

folderState
boolean
Default: false

include user states (fav,rate) on folder(s)

folderCounts
boolean
Default: false

include information about children (trackCount/folderCount) on folder(s)

folderHealth
boolean
Default: false

include information about the meta data quality on folder(s)

folderParents
boolean
Default: false

include a list of all parent folder ids on folder(s)

folderInfo
boolean
Default: false

include extended meta data on folder(s)

folderSimilar
boolean
Default: false

include similar folders list on folder(s) - only for folders of type artist

folderArtworks
boolean
Default: false

include artwork images list on folder(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/subfolders
A local JamServe API
http://localhost:4040/api/v1/folder/subfolders

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

folderController.artistSimilar

get similar artist folders of a folder by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

folderTag
boolean
Default: false

include tag on folder(s)

folderState
boolean
Default: false

include user states (fav,rate) on folder(s)

folderCounts
boolean
Default: false

include information about children (trackCount/folderCount) on folder(s)

folderHealth
boolean
Default: false

include information about the meta data quality on folder(s)

folderParents
boolean
Default: false

include a list of all parent folder ids on folder(s)

folderInfo
boolean
Default: false

include extended meta data on folder(s)

folderSimilar
boolean
Default: false

include similar folders list on folder(s) - only for folders of type artist

folderArtworks
boolean
Default: false

include artwork images list on folder(s)

folderChildren
boolean
Default: false

include tracks and sub folders on folder(s)

folderSubfolders
boolean
Default: false

include sub folders on folder(s)

folderTracks
boolean
Default: false

include tracks on folder(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/artist/similar
A local JamServe API
http://localhost:4040/api/v1/folder/artist/similar

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

folderController.artistInfo

get external artist description of a folder by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/artist/info
A local JamServe API
http://localhost:4040/api/v1/folder/artist/info

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "info":
    {
    }
}

folderController.albumInfo

get external album description of a folder by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/album/info
A local JamServe API
http://localhost:4040/api/v1/folder/album/info

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "info":
    {
    }
}

folderController.list

get a list of folders by list type

Authorizations:
cookieAuthbearerAuth
query Parameters
id
string

filter by id

rootID
string

filter by root id

parentID
string

filter by parent folder id

childOfID
string

filter if folder is in folder id (or its subfolders)

artist
string

filter by artist name

title
string

filter by title

album
string

filter by album name

genre
string

filter by genre

level
number

filter by level

newerThan
integer >= 0

filter by creation date (unix time)

fromYear
integer >= 0

filter by year

toYear
integer >= 0

filter by year

type
string
Enum:"album" "artist" "collection" "extras" "multialbum" "unknown"

filter by folder type

types
Array of string
Items Enum:"album" "artist" "collection" "extras" "multialbum" "unknown"

filter by folder types

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

folderTag
boolean
Default: false

include tag on folder(s)

folderState
boolean
Default: false

include user states (fav,rate) on folder(s)

folderCounts
boolean
Default: false

include information about children (trackCount/folderCount) on folder(s)

folderHealth
boolean
Default: false

include information about the meta data quality on folder(s)

folderParents
boolean
Default: false

include a list of all parent folder ids on folder(s)

folderInfo
boolean
Default: false

include extended meta data on folder(s)

folderSimilar
boolean
Default: false

include similar folders list on folder(s) - only for folders of type artist

folderArtworks
boolean
Default: false

include artwork images list on folder(s)

list
required
string (JamParameters.ListType)
Enum:"avghighest" "faved" "frequent" "highest" "random" "recent"

the type of the item list

offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /folder/list
A local JamServe API
http://localhost:4040/api/v1/folder/list

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

folderController.search

search folders

Authorizations:
cookieAuthbearerAuth
query Parameters
offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

id
string

filter by id

rootID
string

filter by root id

parentID
string

filter by parent folder id

childOfID
string

filter if folder is in folder id (or its subfolders)

artist
string

filter by artist name

title
string

filter by title

album
string

filter by album name

genre
string

filter by genre

level
number

filter by level

newerThan
integer >= 0

filter by creation date (unix time)

fromYear
integer >= 0

filter by year

toYear
integer >= 0

filter by year

type
string
Enum:"album" "artist" "collection" "extras" "multialbum" "unknown"

filter by folder type

types
Array of string
Items Enum:"album" "artist" "collection" "extras" "multialbum" "unknown"

filter by folder types

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

folderChildren
boolean
Default: false

include tracks and sub folders on folder(s)

folderSubfolders
boolean
Default: false

include sub folders on folder(s)

folderTracks
boolean
Default: false

include tracks on folder(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

folderTag
boolean
Default: false

include tag on folder(s)

folderState
boolean
Default: false

include user states (fav,rate) on folder(s)

folderCounts
boolean
Default: false

include information about children (trackCount/folderCount) on folder(s)

folderHealth
boolean
Default: false

include information about the meta data quality on folder(s)

folderParents
boolean
Default: false

include a list of all parent folder ids on folder(s)

folderInfo
boolean
Default: false

include extended meta data on folder(s)

folderSimilar
boolean
Default: false

include similar folders list on folder(s) - only for folders of type artist

folderArtworks
boolean
Default: false

include artwork images list on folder(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /folder/search
A local JamServe API
http://localhost:4040/api/v1/folder/search

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

folderController.health

list of folders with health issues

Authorizations:
cookieAuthbearerAuth
query Parameters
id
string

filter by id

rootID
string

filter by root id

parentID
string

filter by parent folder id

childOfID
string

filter if folder is in folder id (or its subfolders)

artist
string

filter by artist name

title
string

filter by title

album
string

filter by album name

genre
string

filter by genre

level
number

filter by level

newerThan
integer >= 0

filter by creation date (unix time)

fromYear
integer >= 0

filter by year

toYear
integer >= 0

filter by year

type
string
Enum:"album" "artist" "collection" "extras" "multialbum" "unknown"

filter by folder type

types
Array of string
Items Enum:"album" "artist" "collection" "extras" "multialbum" "unknown"

filter by folder types

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

folderTag
boolean
Default: false

include tag on folder(s)

folderState
boolean
Default: false

include user states (fav,rate) on folder(s)

folderCounts
boolean
Default: false

include information about children (trackCount/folderCount) on folder(s)

folderHealth
boolean
Default: false

include information about the meta data quality on folder(s)

folderParents
boolean
Default: false

include a list of all parent folder ids on folder(s)

folderInfo
boolean
Default: false

include extended meta data on folder(s)

folderSimilar
boolean
Default: false

include similar folders list on folder(s) - only for folders of type artist

folderArtworks
boolean
Default: false

include artwork images list on folder(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /folder/health
A local JamServe API
http://localhost:4040/api/v1/folder/health

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

folderController.state

get the user state (fav/rating) by folder id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/state
A local JamServe API
http://localhost:4040/api/v1/folder/state

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "played": 0,
  • "lastplayed": 0,
  • "faved": 0,
  • "rated": 0
}

folderController.states

get the user states (fav/rating) by folders ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/states
A local JamServe API
http://localhost:4040/api/v1/folder/states

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

folderController.artistSimilarTracks

get similar tracks of a/by artist folder id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/artist/similar/tracks
A local JamServe API
http://localhost:4040/api/v1/folder/artist/similar/tracks

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

folderController.artworks

get the artwork list by folder id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/artworks
A local JamServe API
http://localhost:4040/api/v1/folder/artworks

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

folderController.download

download folder as binary archive

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "zip"
Enum:"tar" "zip"

format of download stream

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/download
A local JamServe API
http://localhost:4040/api/v1/folder/download

folderController.image

download default image as binary

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "png"
Enum:"bmp" "jpeg" "jpg" "png" "tiff"

format of the image

size
integer [ 16 .. 1024 ]

size of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/image
A local JamServe API
http://localhost:4040/api/v1/folder/image

folderController.artworkImage

download artwork image as binary

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "png"
Enum:"bmp" "jpeg" "jpg" "png" "tiff"

format of the image

size
integer [ 16 .. 1024 ]

size of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /folder/artwork/image
A local JamServe API
http://localhost:4040/api/v1/folder/artwork/image

folderController.imageUploadUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /folder/imageUpload/update
A local JamServe API
http://localhost:4040/api/v1/folder/imageUpload/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string"
}

folderController.artworkCreate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
url
required
string

url of an image

types
required
Array of string
Items Enum:"artist" "back" "booklet" "front" "liner" "medium" "obi" "other" "poster" "raw" "spine" "sticker" "track" "tray" "unedited" "watermark"

types of the image

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /folder/artwork/create
A local JamServe API
http://localhost:4040/api/v1/folder/artwork/create

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "url": "string",
  • "types":
    [
    ],
  • "id": "string"
}

folderController.artworkDelete

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /folder/artwork/delete
A local JamServe API
http://localhost:4040/api/v1/folder/artwork/delete

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string"
}

folderController.nameUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
name
required
string

the new folder name

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /folder/name/update
A local JamServe API
http://localhost:4040/api/v1/folder/name/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "id": "string"
}

folderController.favUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
remove
boolean
Default: false

add or remove the item fav

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /folder/fav/update
A local JamServe API
http://localhost:4040/api/v1/folder/fav/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "remove": false,
  • "id": "string"
}

folderController.rateUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
rating
required
integer [ 0 .. 5 ]

the rating for the item

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /folder/rate/update
A local JamServe API
http://localhost:4040/api/v1/folder/rate/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "rating": 0,
  • "id": "string"
}

track

trackController.id

get a track by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /track/id
A local JamServe API
http://localhost:4040/api/v1/track/id

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "duration": 0,
  • "tag":
    {
    },
  • "tagID3":
    {
    },
  • "media":
    {
    },
  • "parentID": "string",
  • "artistID": "string",
  • "albumID": "string",
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

trackController.ids

get tracks by ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /track/ids
A local JamServe API
http://localhost:4040/api/v1/track/ids

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

trackController.tagID3

get an id3 tag by track id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /track/tagID3
A local JamServe API
http://localhost:4040/api/v1/track/tagID3

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "version": 0,
  • "frames":
    {
    }
}

trackController.tagID3s

get id3 tags by track ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /track/tagID3s
A local JamServe API
http://localhost:4040/api/v1/track/tagID3s

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

trackController.search

search tracks

Authorizations:
cookieAuthbearerAuth
query Parameters
offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

artist
string

filter by artist name

artistID
string

filter by artist id

parentID
string

filter by parent folder id

parentIDs
Array of string

filter by parent folder ids

childOfID
string

filter if track is in folder id (or its subfolders)

rootID
string

filter by root id

title
string

filter by title

album
string

filter by album

genre
string

filter by genre

newerThan
integer

filter by creation date

fromYear
integer

filter by year

toYear
integer

filter by year

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /track/search
A local JamServe API
http://localhost:4040/api/v1/track/search

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

trackController.state

get the user state (fav/rating) by track id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /track/state
A local JamServe API
http://localhost:4040/api/v1/track/state

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "played": 0,
  • "lastplayed": 0,
  • "faved": 0,
  • "rated": 0
}

trackController.states

get the user states (fav/rating) by track ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /track/states
A local JamServe API
http://localhost:4040/api/v1/track/states

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

trackController.list

get a track list by track list type

Authorizations:
cookieAuthbearerAuth
query Parameters
artist
string

filter by artist name

artistID
string

filter by artist id

parentID
string

filter by parent folder id

parentIDs
Array of string

filter by parent folder ids

childOfID
string

filter if track is in folder id (or its subfolders)

rootID
string

filter by root id

title
string

filter by title

album
string

filter by album

genre
string

filter by genre

newerThan
integer

filter by creation date

fromYear
integer

filter by year

toYear
integer

filter by year

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

list
required
string (JamParameters.ListType)
Enum:"avghighest" "faved" "frequent" "highest" "random" "recent"

the type of the item list

offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /track/list
A local JamServe API
http://localhost:4040/api/v1/track/list

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

trackController.similar

get the similar tracks by track id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /track/similar
A local JamServe API
http://localhost:4040/api/v1/track/similar

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

trackController.stream

download track media as binary

Authorizations:
cookieAuthbearerAuth
query Parameters
maxBitRate
integer >= 10

maximal bitrate if transcoding (in Kbps)

format
string
Default: "mp3"
Value:"mp3"

format of audio stream

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /track/stream
A local JamServe API
http://localhost:4040/api/v1/track/stream

trackController.download

download track media as binary archive

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "zip"
Enum:"tar" "zip"

format of download stream

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /track/download
A local JamServe API
http://localhost:4040/api/v1/track/download

trackController.image

download default image as binary

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "png"
Enum:"bmp" "jpeg" "jpg" "png" "tiff"

format of the image

size
integer [ 16 .. 1024 ]

size of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /track/image
A local JamServe API
http://localhost:4040/api/v1/track/image

trackController.favUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
remove
boolean
Default: false

add or remove the item fav

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /track/fav/update
A local JamServe API
http://localhost:4040/api/v1/track/fav/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "remove": false,
  • "id": "string"
}

trackController.rateUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
rating
required
integer [ 0 .. 5 ]

the rating for the item

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /track/rate/update
A local JamServe API
http://localhost:4040/api/v1/track/rate/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "rating": 0,
  • "id": "string"
}

trackController.tagID3Update

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
id
required
string

the id of the track

tag
required
object (Jam.ID3Tag)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /track/tagID3/update
A local JamServe API
http://localhost:4040/api/v1/track/tagID3/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "tag":
    {
    }
}

trackController.nameUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
name
required
string

the new track file name

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /track/name/update
A local JamServe API
http://localhost:4040/api/v1/track/name/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "id": "string"
}

episode

episodeController.id

get a podcast episode by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /episode/id
A local JamServe API
http://localhost:4040/api/v1/episode/id

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "podcastID": "string",
  • "status": "completed",
  • "date": 0,
  • "summary": "string",
  • "guid": "string",
  • "author": "string",
  • "link": "string",
  • "errorMessage": "string",
  • "duration": 0,
  • "tag":
    {
    },
  • "tagID3":
    {
    },
  • "media":
    {
    },
  • "parentID": "string",
  • "artistID": "string",
  • "albumID": "string",
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

episodeController.ids

get podcast episodes by ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /episode/ids
A local JamServe API
http://localhost:4040/api/v1/episode/ids

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

episodeController.search

search podcast episodes

Authorizations:
cookieAuthbearerAuth
query Parameters
offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

podcastID
string

filter by podcast id

name
string

filter by title

status
string

filter by status

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /episode/search
A local JamServe API
http://localhost:4040/api/v1/episode/search

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

episodeController.retrieve

retrieve a podcast episode media file

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /episode/retrieve
A local JamServe API
http://localhost:4040/api/v1/episode/retrieve

episodeController.state

get the user state (fav/rating) by podcast episode id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /episode/state
A local JamServe API
http://localhost:4040/api/v1/episode/state

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "played": 0,
  • "lastplayed": 0,
  • "faved": 0,
  • "rated": 0
}

episodeController.states

get the user states (fav/rating) by podcast episode ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /episode/states
A local JamServe API
http://localhost:4040/api/v1/episode/states

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

episodeController.status

get the episode state (e.g. downloading, new, etc.) by podcast episode id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /episode/status
A local JamServe API
http://localhost:4040/api/v1/episode/status

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "status": "completed"
}

episodeController.list

get a list of episodes by list type

Authorizations:
cookieAuthbearerAuth
query Parameters
podcastID
string

filter by podcast id

name
string

filter by title

status
string

filter by status

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

list
required
string (JamParameters.ListType)
Enum:"avghighest" "faved" "frequent" "highest" "random" "recent"

the type of the item list

offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /episode/list
A local JamServe API
http://localhost:4040/api/v1/episode/list

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

episodeController.stream

download episode media as binary

Authorizations:
cookieAuthbearerAuth
query Parameters
maxBitRate
integer >= 10

maximal bitrate if transcoding (in Kbps)

format
string
Default: "mp3"
Value:"mp3"

format of audio stream

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /episode/stream
A local JamServe API
http://localhost:4040/api/v1/episode/stream

episodeController.download

download episode media as binary archive

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "zip"
Enum:"tar" "zip"

format of download stream

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /episode/download
A local JamServe API
http://localhost:4040/api/v1/episode/download

episodeController.image

download default image as binary

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "png"
Enum:"bmp" "jpeg" "jpg" "png" "tiff"

format of the image

size
integer [ 16 .. 1024 ]

size of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /episode/image
A local JamServe API
http://localhost:4040/api/v1/episode/image

episodeController.favUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
remove
boolean
Default: false

add or remove the item fav

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /episode/fav/update
A local JamServe API
http://localhost:4040/api/v1/episode/fav/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "remove": false,
  • "id": "string"
}

episodeController.rateUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
rating
required
integer [ 0 .. 5 ]

the rating for the item

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /episode/rate/update
A local JamServe API
http://localhost:4040/api/v1/episode/rate/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "rating": 0,
  • "id": "string"
}

podcast

podcastController.id

get a podcast by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

podcastState
boolean
Default: false

include user states (fav,rate) on podcast(s)

podcastEpisodes
boolean
Default: false

include episodes on podcast(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /podcast/id
A local JamServe API
http://localhost:4040/api/v1/podcast/id

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "url": "string",
  • "status": "completed",
  • "lastCheck": 0,
  • "errorMessage": "string",
  • "description": "string",
  • "episodes":
    [
    ],
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

podcastController.ids

get podcasts by ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

podcastState
boolean
Default: false

include user states (fav,rate) on podcast(s)

podcastEpisodes
boolean
Default: false

include episodes on podcast(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /podcast/ids
A local JamServe API
http://localhost:4040/api/v1/podcast/ids

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

podcastController.status

get the podcast state (e.g. downloading, new, etc.) by podcast id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /podcast/status
A local JamServe API
http://localhost:4040/api/v1/podcast/status

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "status": "completed",
  • "lastCheck": 0
}

podcastController.search

search podcasts

Authorizations:
cookieAuthbearerAuth
query Parameters
offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

url
string

filter by podcast url

title
string

filter by podcast title

status
string

filter by podcast status

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

podcastState
boolean
Default: false

include user states (fav,rate) on podcast(s)

podcastEpisodes
boolean
Default: false

include episodes on podcast(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /podcast/search
A local JamServe API
http://localhost:4040/api/v1/podcast/search

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

podcastController.refreshAll

check all podcast feeds for new episodes

Authorizations:
cookieAuthbearerAuth

Responses

200

ok

get /podcast/refreshAll
A local JamServe API
http://localhost:4040/api/v1/podcast/refreshAll

podcastController.refresh

check podcast feeds for new episodes by podcast id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /podcast/refresh
A local JamServe API
http://localhost:4040/api/v1/podcast/refresh

podcastController.state

get the user state (fav/rating) by podcast id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /podcast/state
A local JamServe API
http://localhost:4040/api/v1/podcast/state

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "played": 0,
  • "lastplayed": 0,
  • "faved": 0,
  • "rated": 0
}

podcastController.states

get the user states (fav/rating) by podcast ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /podcast/states
A local JamServe API
http://localhost:4040/api/v1/podcast/states

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

podcastController.list

get a list of podcasts by list type

Authorizations:
cookieAuthbearerAuth
query Parameters
url
string

filter by podcast url

title
string

filter by podcast title

status
string

filter by podcast status

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

podcastState
boolean
Default: false

include user states (fav,rate) on podcast(s)

podcastEpisodes
boolean
Default: false

include episodes on podcast(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

list
required
string (JamParameters.ListType)
Enum:"avghighest" "faved" "frequent" "highest" "random" "recent"

the type of the item list

offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /podcast/list
A local JamServe API
http://localhost:4040/api/v1/podcast/list

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

podcastController.image

download default image as binary

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "png"
Enum:"bmp" "jpeg" "jpg" "png" "tiff"

format of the image

size
integer [ 16 .. 1024 ]

size of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /podcast/image
A local JamServe API
http://localhost:4040/api/v1/podcast/image

podcastController.download

download podcast episodes as binary archive

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "zip"
Enum:"tar" "zip"

format of download stream

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /podcast/download
A local JamServe API
http://localhost:4040/api/v1/podcast/download

podcastController.create

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
url
required
string

podcast feed url

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

post /podcast/create
A local JamServe API
http://localhost:4040/api/v1/podcast/create

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "url": "string"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "url": "string",
  • "status": "completed",
  • "lastCheck": 0,
  • "errorMessage": "string",
  • "description": "string",
  • "episodes":
    [
    ],
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

podcastController.favUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
remove
boolean
Default: false

add or remove the item fav

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /podcast/fav/update
A local JamServe API
http://localhost:4040/api/v1/podcast/fav/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "remove": false,
  • "id": "string"
}

podcastController.rateUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
rating
required
integer [ 0 .. 5 ]

the rating for the item

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /podcast/rate/update
A local JamServe API
http://localhost:4040/api/v1/podcast/rate/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "rating": 0,
  • "id": "string"
}

podcastController.delete

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /podcast/delete
A local JamServe API
http://localhost:4040/api/v1/podcast/delete

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string"
}

radio

radioController.id

get a radio by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

radioState
required
boolean
Default: false

include user states (fav,rate) on radio(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /radio/id
A local JamServe API
http://localhost:4040/api/v1/radio/id

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "url": "string",
  • "homepage": "string",
  • "created": 0,
  • "changed": 0,
  • "id": "string",
  • "state":
    {
    },
  • "name": "string"
}

radioController.ids

get radios by ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

radioState
required
boolean
Default: false

include user states (fav,rate) on radio(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /radio/ids
A local JamServe API
http://localhost:4040/api/v1/radio/ids

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

radioController.search

search radios

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

radioState
required
boolean
Default: false

include user states (fav,rate) on radio(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /radio/search
A local JamServe API
http://localhost:4040/api/v1/radio/search

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

radioController.state

get the user state (fav/rating) by radio id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /radio/state
A local JamServe API
http://localhost:4040/api/v1/radio/state

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "played": 0,
  • "lastplayed": 0,
  • "faved": 0,
  • "rated": 0
}

radioController.states

get the user states (fav/rating) by radio ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /radio/states
A local JamServe API
http://localhost:4040/api/v1/radio/states

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

radioController.create

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
name
required
string

radio name

url
required
string

radio stream url

homepage
string

radio homepage url

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

post /radio/create
A local JamServe API
http://localhost:4040/api/v1/radio/create

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "url": "string",
  • "homepage": "string"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "url": "string",
  • "homepage": "string",
  • "created": 0,
  • "changed": 0,
  • "id": "string",
  • "state":
    {
    },
  • "name": "string"
}

radioController.update

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
name
string

radio name

url
string

radio stream url

homepage
string

radio homepage url

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /radio/update
A local JamServe API
http://localhost:4040/api/v1/radio/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "url": "string",
  • "homepage": "string",
  • "id": "string"
}

radioController.delete

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /radio/delete
A local JamServe API
http://localhost:4040/api/v1/radio/delete

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string"
}

artist

artistController.id

get an artist by id

Authorizations:
cookieAuthbearerAuth
query Parameters
rootID
string

filter by root id

id
required
string

the item id

artistAlbums
boolean
Default: false

include albums on artist(s)

artistAlbumIDs
boolean
Default: false

include album ids on artist(s)

artistState
boolean
Default: false

include user states (fav,rate) on artist(s)

artistTracks
boolean
Default: false

include tracks on artist(s)

artistTracksIDs
boolean
Default: false

include track ids on artist(s)

artistInfo
boolean
Default: false

include extended meta data on artist(s)

artistSimilar
boolean
Default: false

include similar artists on artist(s)

albumTracks
boolean
Default: false

include tracks on album(s)

albumTrackIDs
boolean
Default: false

include track ids on album(s)

albumState
boolean
Default: false

include user states (fav,rate) on album(s)

albumInfo
boolean
Default: false

include extended meta data on album(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /artist/id
A local JamServe API
http://localhost:4040/api/v1/artist/id

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "albumCount": 0,
  • "trackCount": 0,
  • "musicbrainz":
    {
    },
  • "albumTypes":
    [
    ],
  • "tracks":
    [
    ],
  • "trackIDs":
    [
    ],
  • "albumIDs":
    [
    ],
  • "albums":
    [
    ],
  • "similar":
    [
    ],
  • "info":
    {
    },
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

artistController.ids

get artists by ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

artistAlbums
boolean
Default: false

include albums on artist(s)

artistAlbumIDs
boolean
Default: false

include album ids on artist(s)

artistState
boolean
Default: false

include user states (fav,rate) on artist(s)

artistTracks
boolean
Default: false

include tracks on artist(s)

artistTracksIDs
boolean
Default: false

include track ids on artist(s)

artistInfo
boolean
Default: false

include extended meta data on artist(s)

artistSimilar
boolean
Default: false

include similar artists on artist(s)

albumTracks
boolean
Default: false

include tracks on album(s)

albumTrackIDs
boolean
Default: false

include track ids on album(s)

albumState
boolean
Default: false

include user states (fav,rate) on album(s)

albumInfo
boolean
Default: false

include extended meta data on album(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /artist/ids
A local JamServe API
http://localhost:4040/api/v1/artist/ids

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

artistController.search

search artists

Authorizations:
cookieAuthbearerAuth
query Parameters
offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

name
string

filter by name

rootID
string

filter by root id

albumID
string

filter by album id

mbArtistID
string

filter by musicbrainz album id

newerThan
integer >= 0

filter by creation date (unix time)

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

artistAlbums
boolean
Default: false

include albums on artist(s)

artistAlbumIDs
boolean
Default: false

include album ids on artist(s)

artistState
boolean
Default: false

include user states (fav,rate) on artist(s)

artistTracks
boolean
Default: false

include tracks on artist(s)

artistTracksIDs
boolean
Default: false

include track ids on artist(s)

artistInfo
boolean
Default: false

include extended meta data on artist(s)

artistSimilar
boolean
Default: false

include similar artists on artist(s)

albumTracks
boolean
Default: false

include tracks on album(s)

albumTrackIDs
boolean
Default: false

include track ids on album(s)

albumState
boolean
Default: false

include user states (fav,rate) on album(s)

albumInfo
boolean
Default: false

include extended meta data on album(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /artist/search
A local JamServe API
http://localhost:4040/api/v1/artist/search

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

artistController.state

get the user state (fav/rating) by artist id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /artist/state
A local JamServe API
http://localhost:4040/api/v1/artist/state

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "played": 0,
  • "lastplayed": 0,
  • "faved": 0,
  • "rated": 0
}

artistController.states

get the user states (fav/rating) by artist ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /artist/states
A local JamServe API
http://localhost:4040/api/v1/artist/states

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

artistController.list

get a artist list by artist list type

Authorizations:
cookieAuthbearerAuth
query Parameters
name
string

filter by name

rootID
string

filter by root id

albumID
string

filter by album id

mbArtistID
string

filter by musicbrainz album id

newerThan
integer >= 0

filter by creation date (unix time)

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

artistAlbums
boolean
Default: false

include albums on artist(s)

artistAlbumIDs
boolean
Default: false

include album ids on artist(s)

artistState
boolean
Default: false

include user states (fav,rate) on artist(s)

artistTracks
boolean
Default: false

include tracks on artist(s)

artistTracksIDs
boolean
Default: false

include track ids on artist(s)

artistInfo
boolean
Default: false

include extended meta data on artist(s)

artistSimilar
boolean
Default: false

include similar artists on artist(s)

albumTracks
boolean
Default: false

include tracks on album(s)

albumTrackIDs
boolean
Default: false

include track ids on album(s)

albumState
boolean
Default: false

include user states (fav,rate) on album(s)

albumInfo
boolean
Default: false

include extended meta data on album(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

list
required
string (JamParameters.ListType)
Enum:"avghighest" "faved" "frequent" "highest" "random" "recent"

the type of the item list

offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /artist/list
A local JamServe API
http://localhost:4040/api/v1/artist/list

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

artistController.similarTracks

get similar tracks of an artist by artist id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /artist/similar/tracks
A local JamServe API
http://localhost:4040/api/v1/artist/similar/tracks

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

artistController.similar

get similar artists of an artist by artist id

Authorizations:
cookieAuthbearerAuth
query Parameters
rootID
string

filter by root id

id
required
string

the item id

artistAlbums
boolean
Default: false

include albums on artist(s)

artistAlbumIDs
boolean
Default: false

include album ids on artist(s)

artistState
boolean
Default: false

include user states (fav,rate) on artist(s)

artistTracks
boolean
Default: false

include tracks on artist(s)

artistTracksIDs
boolean
Default: false

include track ids on artist(s)

artistInfo
boolean
Default: false

include extended meta data on artist(s)

artistSimilar
boolean
Default: false

include similar artists on artist(s)

albumTracks
boolean
Default: false

include tracks on album(s)

albumTrackIDs
boolean
Default: false

include track ids on album(s)

albumState
boolean
Default: false

include user states (fav,rate) on album(s)

albumInfo
boolean
Default: false

include extended meta data on album(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /artist/similar
A local JamServe API
http://localhost:4040/api/v1/artist/similar

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

artistController.index

get the navigation index for artists

Authorizations:
cookieAuthbearerAuth
query Parameters
rootID
string

filter by root id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /artist/index
A local JamServe API
http://localhost:4040/api/v1/artist/index

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "lastModified": 0,
  • "groups":
    [
    ]
}

artistController.info

get external artist description by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /artist/info
A local JamServe API
http://localhost:4040/api/v1/artist/info

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "info":
    {
    }
}

artistController.image

download default image as binary

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "png"
Enum:"bmp" "jpeg" "jpg" "png" "tiff"

format of the image

size
integer [ 16 .. 1024 ]

size of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /artist/image
A local JamServe API
http://localhost:4040/api/v1/artist/image

artistController.download

download artist tracks as binary archive

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "zip"
Enum:"tar" "zip"

format of download stream

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /artist/download
A local JamServe API
http://localhost:4040/api/v1/artist/download

artistController.favUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
remove
boolean
Default: false

add or remove the item fav

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /artist/fav/update
A local JamServe API
http://localhost:4040/api/v1/artist/fav/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "remove": false,
  • "id": "string"
}

artistController.rateUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
rating
required
integer [ 0 .. 5 ]

the rating for the item

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /artist/rate/update
A local JamServe API
http://localhost:4040/api/v1/artist/rate/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "rating": 0,
  • "id": "string"
}

album

artistController.tracks

get tracks of an artist by artist id

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /artist/tracks
A local JamServe API
http://localhost:4040/api/v1/artist/tracks

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

albumController.id

get an album by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

albumTracks
boolean
Default: false

include tracks on album(s)

albumTrackIDs
boolean
Default: false

include track ids on album(s)

albumState
boolean
Default: false

include user states (fav,rate) on album(s)

albumInfo
boolean
Default: false

include extended meta data on album(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /album/id
A local JamServe API
http://localhost:4040/api/v1/album/id

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "artist": "string",
  • "tag":
    {
    },
  • "albumType": "album",
  • "trackCount": 0,
  • "artistID": "string",
  • "trackIDs":
    [
    ],
  • "tracks":
    [
    ],
  • "info":
    {
    },
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

albumController.ids

get albums by ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

albumTracks
boolean
Default: false

include tracks on album(s)

albumTrackIDs
boolean
Default: false

include track ids on album(s)

albumState
boolean
Default: false

include user states (fav,rate) on album(s)

albumInfo
boolean
Default: false

include extended meta data on album(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /album/ids
A local JamServe API
http://localhost:4040/api/v1/album/ids

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

albumController.list

get a artist list by album list type

Authorizations:
cookieAuthbearerAuth
query Parameters
offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

albumTracks
boolean
Default: false

include tracks on album(s)

albumTrackIDs
boolean
Default: false

include track ids on album(s)

albumState
boolean
Default: false

include user states (fav,rate) on album(s)

albumInfo
boolean
Default: false

include extended meta data on album(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

name
string

filter by name

rootID
string

filter by root id

artist
string

filter by artist name

artistID
string

filter by artist id

trackID
string

filter by track id

mbAlbumID
string

filter by album id

mbArtistID
string

filter by artist id

genre
string

filter by genre

albumType
string
Enum:"album" "audiobook" "compilation" "unknown"

filter by album type

albumTypes
Array of string
Items Enum:"album" "audiobook" "compilation" "unknown"

filter by album types

newerThan
integer >= 0

filter by creation date (unix time)

fromYear
integer >= 0

filter by year

toYear
integer >= 0

filter by year

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

list
required
string (JamParameters.ListType)
Enum:"avghighest" "faved" "frequent" "highest" "random" "recent"

the type of the item list

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /album/list
A local JamServe API
http://localhost:4040/api/v1/album/list

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

albumController.search

search albums

Authorizations:
cookieAuthbearerAuth
query Parameters
offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

name
string

filter by name

rootID
string

filter by root id

artist
string

filter by artist name

artistID
string

filter by artist id

trackID
string

filter by track id

mbAlbumID
string

filter by album id

mbArtistID
string

filter by artist id

genre
string

filter by genre

albumType
string
Enum:"album" "audiobook" "compilation" "unknown"

filter by album type

albumTypes
Array of string
Items Enum:"album" "audiobook" "compilation" "unknown"

filter by album types

newerThan
integer >= 0

filter by creation date (unix time)

fromYear
integer >= 0

filter by year

toYear
integer >= 0

filter by year

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

albumTracks
boolean
Default: false

include tracks on album(s)

albumTrackIDs
boolean
Default: false

include track ids on album(s)

albumState
boolean
Default: false

include user states (fav,rate) on album(s)

albumInfo
boolean
Default: false

include extended meta data on album(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /album/search
A local JamServe API
http://localhost:4040/api/v1/album/search

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

albumController.state

get the user state (fav/rating) by album id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /album/state
A local JamServe API
http://localhost:4040/api/v1/album/state

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "played": 0,
  • "lastplayed": 0,
  • "faved": 0,
  • "rated": 0
}

albumController.states

get the user states (fav/rating) by album ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /album/states
A local JamServe API
http://localhost:4040/api/v1/album/states

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

albumController.similarTracks

get similar tracks of an artist by album id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /album/similar/tracks
A local JamServe API
http://localhost:4040/api/v1/album/similar/tracks

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

albumController.tracks

get tracks of an album by album id

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /album/tracks
A local JamServe API
http://localhost:4040/api/v1/album/tracks

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

albumController.info

get external album description by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /album/info
A local JamServe API
http://localhost:4040/api/v1/album/info

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "info":
    {
    }
}

albumController.image

download default image as binary

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "png"
Enum:"bmp" "jpeg" "jpg" "png" "tiff"

format of the image

size
integer [ 16 .. 1024 ]

size of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /album/image
A local JamServe API
http://localhost:4040/api/v1/album/image

albumController.download

download album tracks as binary archive

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "zip"
Enum:"tar" "zip"

format of download stream

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /album/download
A local JamServe API
http://localhost:4040/api/v1/album/download

albumController.favUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
remove
boolean
Default: false

add or remove the item fav

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /album/fav/update
A local JamServe API
http://localhost:4040/api/v1/album/fav/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "remove": false,
  • "id": "string"
}

albumController.rateUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
rating
required
integer [ 0 .. 5 ]

the rating for the item

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /album/rate/update
A local JamServe API
http://localhost:4040/api/v1/album/rate/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "rating": 0,
  • "id": "string"
}

playlist

playlistController.id

get a playlist by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

playlistTracks
boolean
Default: false

include tracks on playlist(s)

playlistTracksIDs
boolean
Default: false

include track ids on playlist(s)

playlistState
boolean
Default: false

include user states (fav,rate) on playlist(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /playlist/id
A local JamServe API
http://localhost:4040/api/v1/playlist/id

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "userID": "string",
  • "isPublic": true,
  • "comment": "string",
  • "duration": 0,
  • "trackCount": 0,
  • "changed": 0,
  • "tracks":
    [
    ],
  • "trackIDs":
    [
    ],
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

playlistController.ids

get playlists by ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

playlistTracks
boolean
Default: false

include tracks on playlist(s)

playlistTracksIDs
boolean
Default: false

include track ids on playlist(s)

playlistState
boolean
Default: false

include user states (fav,rate) on playlist(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /playlist/ids
A local JamServe API
http://localhost:4040/api/v1/playlist/ids

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

playlistController.search

search playlists

Authorizations:
cookieAuthbearerAuth
query Parameters
offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

name
string

filter by playlist name

isPublic
boolean

filter by public state

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

playlistTracks
boolean
Default: false

include tracks on playlist(s)

playlistTracksIDs
boolean
Default: false

include track ids on playlist(s)

playlistState
boolean
Default: false

include user states (fav,rate) on playlist(s)

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /playlist/search
A local JamServe API
http://localhost:4040/api/v1/playlist/search

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

playlistController.state

get the user state (fav/rating) by playlist id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /playlist/state
A local JamServe API
http://localhost:4040/api/v1/playlist/state

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "played": 0,
  • "lastplayed": 0,
  • "faved": 0,
  • "rated": 0
}

playlistController.states

get the user states (fav/rating) by playlist ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /playlist/states
A local JamServe API
http://localhost:4040/api/v1/playlist/states

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "property1":
    {
    },
  • "property2":
    {
    }
}

playlistController.tracks

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /playlist/tracks
A local JamServe API
http://localhost:4040/api/v1/playlist/tracks

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

playlistController.image

download default image as binary

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "png"
Enum:"bmp" "jpeg" "jpg" "png" "tiff"

format of the image

size
integer [ 16 .. 1024 ]

size of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /playlist/image
A local JamServe API
http://localhost:4040/api/v1/playlist/image

playlistController.download

download playlist tracks as binary archive

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "zip"
Enum:"tar" "zip"

format of download stream

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /playlist/download
A local JamServe API
http://localhost:4040/api/v1/playlist/download

playlistController.create

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
name
required
string

name of playlist

comment
string

a comment

isPublic
boolean

set the playlist visible for other users or not

trackIDs
Array of string

track ids of the playlist, may include duplicates

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

post /playlist/create
A local JamServe API
http://localhost:4040/api/v1/playlist/create

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "comment": "string",
  • "isPublic": true,
  • "trackIDs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "userID": "string",
  • "isPublic": true,
  • "comment": "string",
  • "duration": 0,
  • "trackCount": 0,
  • "changed": 0,
  • "tracks":
    [
    ],
  • "trackIDs":
    [
    ],
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

playlistController.update

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
name
string

name of playlist

comment
string

a comment

isPublic
boolean

set the playlist visible for other users or not

trackIDs
Array of string

track ids of the playlist, may include duplicates

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /playlist/update
A local JamServe API
http://localhost:4040/api/v1/playlist/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "comment": "string",
  • "isPublic": true,
  • "trackIDs":
    [
    ],
  • "id": "string"
}

playlistController.favUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
remove
boolean
Default: false

add or remove the item fav

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /playlist/fav/update
A local JamServe API
http://localhost:4040/api/v1/playlist/fav/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "remove": false,
  • "id": "string"
}

playlistController.rateUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
rating
required
integer [ 0 .. 5 ]

the rating for the item

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /playlist/rate/update
A local JamServe API
http://localhost:4040/api/v1/playlist/rate/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "rating": 0,
  • "id": "string"
}

playlistController.delete

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /playlist/delete
A local JamServe API
http://localhost:4040/api/v1/playlist/delete

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string"
}

user

userController.id

get an user by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /user/id
A local JamServe API
http://localhost:4040/api/v1/user/id

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "email": "string",
  • "roles":
    {
    },
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

userController.ids

get users by ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /user/ids
A local JamServe API
http://localhost:4040/api/v1/user/ids

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

userController.search

search users

Authorizations:
cookieAuthbearerAuth
query Parameters
offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

name
string

filter by user name

isAdmin
boolean

filter by user admin role

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /user/search
A local JamServe API
http://localhost:4040/api/v1/user/search

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

userController.image

download default image as binary

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "png"
Enum:"bmp" "jpeg" "jpg" "png" "tiff"

format of the image

size
integer [ 16 .. 1024 ]

size of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /user/image
A local JamServe API
http://localhost:4040/api/v1/user/image

userController.create

create a new user

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
name
required
string

name of the user

email
string

email of the user

roleAdmin
boolean
Default: false

user has admin rights

rolePodcast
boolean
Default: false

user has podcast admin rights

roleStream
boolean
Default: true

user has streaming/download rights

roleUpload
boolean
Default: false

user has upload rights

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

post /user/create
A local JamServe API
http://localhost:4040/api/v1/user/create

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "email": "string",
  • "roleAdmin": false,
  • "rolePodcast": false,
  • "roleStream": true,
  • "roleUpload": false
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "email": "string",
  • "roles":
    {
    },
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

userController.update

update user

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
name
string

name of the user

email
string

email of the user

roleAdmin
boolean

user has admin rights

rolePodcast
boolean

user has podcast admin rights

roleStream
boolean

user has streaming/download rights

roleUpload
boolean

user has upload rights

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /user/update
A local JamServe API
http://localhost:4040/api/v1/user/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "email": "string",
  • "roleAdmin": true,
  • "rolePodcast": true,
  • "roleStream": true,
  • "roleUpload": true,
  • "id": "string"
}

userController.passwordUpdate

set a password for the user

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
password
required
string

new password of user

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /user/password/update
A local JamServe API
http://localhost:4040/api/v1/user/password/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "password": "string",
  • "id": "string"
}

userController.emailUpdate

set an email for an user

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
email
required
string

new email of user

id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /user/email/update
A local JamServe API
http://localhost:4040/api/v1/user/email/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "email": "string",
  • "id": "string"
}

userController.imageUploadUpdate

set an avatar image for an user

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /user/imageUpload/update
A local JamServe API
http://localhost:4040/api/v1/user/imageUpload/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string"
}

userController.delete

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /user/delete
A local JamServe API
http://localhost:4040/api/v1/user/delete

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string"
}

playqueue

playqueueController.get

get a playqueue for calling user

Authorizations:
cookieAuthbearerAuth
query Parameters
playQueueTracks
boolean
Default: false

include tracks on playqueue

playQueueTrackIDs
boolean
Default: false

include track ids on playqueue

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /playqueue/get
A local JamServe API
http://localhost:4040/api/v1/playqueue/get

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "trackIDs":
    [
    ],
  • "tracks":
    [
    ],
  • "currentID": "string",
  • "position": 0,
  • "changed": 0,
  • "changedBy": "string"
}

playqueueController.update

create/update the playqueue for calling user

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
trackIDs
required
Array of string

the track ids of the playqueue

currentID
string

the track id of the current playing track

position
integer >= 0

the position in the current playing track

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /playqueue/update
A local JamServe API
http://localhost:4040/api/v1/playqueue/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "trackIDs":
    [
    ],
  • "currentID": "string",
  • "position": 0
}

playqueueController.delete

delete the playqueue for calling user

Authorizations:
cookieAuthbearerAuth

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /playqueue/delete
A local JamServe API
http://localhost:4040/api/v1/playqueue/delete

bookmark

bookmarkController.list

get a bookmarks list for the calling user

Authorizations:
cookieAuthbearerAuth
query Parameters
bookmarkTrack
boolean
Default: false

include the track of the bookmark

trackMedia
boolean
Default: false

include media informations on track(s)

trackTag
boolean
Default: false

include tag on track(s)

trackID3
boolean
Default: false

include id3 tag on track(s)

trackState
boolean
Default: false

include user states (fav,rate) on track(s)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /bookmark/list
A local JamServe API
http://localhost:4040/api/v1/bookmark/list

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

bookmarkController.create

create a bookmark

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
trackID
string

a track id

comment
string

a comment

position
required
integer >= 0

the position of the bookmark (in ms)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

post /bookmark/create
A local JamServe API
http://localhost:4040/api/v1/bookmark/create

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "trackID": "string",
  • "comment": "string",
  • "position": 0
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "track":
    {
    },
  • "trackID": "string",
  • "position": 0,
  • "comment": "string",
  • "created": 0,
  • "changed": 0
}

bookmarkController.delete

delete a bookmark

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /bookmark/delete
A local JamServe API
http://localhost:4040/api/v1/bookmark/delete

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string"
}

root

rootController.id

get a root by id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /root/id
A local JamServe API
http://localhost:4040/api/v1/root/id

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "path": "string",
  • "status":
    {
    },
  • "strategy": "artistalbum",
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

rootController.ids

get roots by ids

Authorizations:
cookieAuthbearerAuth
query Parameters
ids
required
Array of string

array of item ids

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /root/ids
A local JamServe API
http://localhost:4040/api/v1/root/ids

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

rootController.search

search roots

Authorizations:
cookieAuthbearerAuth
query Parameters
offset
integer >= 0
Default: 0

get back items from position

amount
integer >= 1

get back number of items

query
string

search query

sortField
string

the obj property name to sort on (e.g. 'artist', 'creation')

sortDescending
boolean
Default: false

the sort direction

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /root/search
A local JamServe API
http://localhost:4040/api/v1/root/search

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

rootController.scan

start a root scan by root id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /root/scan
A local JamServe API
http://localhost:4040/api/v1/root/scan

rootController.scanAll

start scan of all roots

Authorizations:
cookieAuthbearerAuth

Responses

200

ok

401

unauthorized

500

internal server error

get /root/scanAll
A local JamServe API
http://localhost:4040/api/v1/root/scanAll

rootController.status

scanning status of a root scan by root id

Authorizations:
cookieAuthbearerAuth
query Parameters
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

get /root/status
A local JamServe API
http://localhost:4040/api/v1/root/status

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "lastScan": 0,
  • "error": "string",
  • "scanning": true
}

rootController.image

download default image as binary

Authorizations:
cookieAuthbearerAuth
query Parameters
format
string
Default: "png"
Enum:"bmp" "jpeg" "jpg" "png" "tiff"

format of the image

size
integer [ 16 .. 1024 ]

size of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /root/image
A local JamServe API
http://localhost:4040/api/v1/root/image

rootController.create

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
name
required
string

name of the root

path
required
string

absolute path of the root

strategy
required
string (Jam.RootScanStrategy)
Enum:"artistalbum" "audiobook" "auto" "compilation"

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

500

internal server error

post /root/create
A local JamServe API
http://localhost:4040/api/v1/root/create

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "path": "string",
  • "strategy": "artistalbum"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "path": "string",
  • "status":
    {
    },
  • "strategy": "artistalbum",
  • "id": "string",
  • "state":
    {
    },
  • "name": "string",
  • "created": 0
}

rootController.update

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
name
required
string

name of the root

path
required
string

absolute path of the root

strategy
required
string (Jam.RootScanStrategy)
Enum:"artistalbum" "audiobook" "auto" "compilation"
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /root/update
A local JamServe API
http://localhost:4040/api/v1/root/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "path": "string",
  • "strategy": "artistalbum",
  • "id": "string"
}

rootController.delete

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
id
required
string

the item id

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /root/delete
A local JamServe API
http://localhost:4040/api/v1/root/delete

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string"
}

settings

settingsController.admin

get admin settings for the server

Authorizations:
cookieAuthbearerAuth

Responses

200

ok

401

unauthorized

500

internal server error

get /settings/admin
A local JamServe API
http://localhost:4040/api/v1/settings/admin

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "chat":
    {
    },
  • "index":
    {
    },
  • "library":
    {
    }
}

settingsController.adminUpdate

Authorizations:
cookieAuthbearerAuth
Request Body schema: application/json
chat
required
object (Jam.AdminSettingsChat)
index
required
object (Jam.AdminSettingsIndex)
library
required
object (Jam.AdminSettingsLibrary)

Responses

200

ok

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

post /settings/admin/update
A local JamServe API
http://localhost:4040/api/v1/settings/admin/update

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "chat":
    {
    },
  • "index":
    {
    },
  • "library":
    {
    }
}

image

imageController.image

download image for object as binary by id

Authorizations:
cookieAuthbearerAuth
path Parameters
format
required
string
Default: "png"
Enum:"bmp" "jpeg" "jpg" "png" "tiff"

format of the image

size
required
integer [ 16 .. 1024 ]

size of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /image/{id}-{size}.{format}
A local JamServe API
http://localhost:4040/api/v1/image/{id}-{size}.{format}

imageController.image

download image for object as binary by id

Authorizations:
cookieAuthbearerAuth
path Parameters
size
required
integer [ 16 .. 1024 ]

size of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /image/{id}-{size}
A local JamServe API
http://localhost:4040/api/v1/image/{id}-{size}

imageController.image

download image for object as binary by id

Authorizations:
cookieAuthbearerAuth
path Parameters
format
required
string
Default: "png"
Enum:"bmp" "jpeg" "jpg" "png" "tiff"

format of the image

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /image/{id}.{format}
A local JamServe API
http://localhost:4040/api/v1/image/{id}.{format}

imageController.image

download image for object as binary by id

Authorizations:
cookieAuthbearerAuth
path Parameters
id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /image/{id}
A local JamServe API
http://localhost:4040/api/v1/image/{id}

media

streamController.stream

stream a media file in a format

Authorizations:
cookieAuthbearerAuth
path Parameters
format
required
string
Default: "mp3"
Value:"mp3"

format of audio stream

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /stream/{id}.{format}
A local JamServe API
http://localhost:4040/api/v1/stream/{id}.{format}

streamController.stream

stream a media file

Authorizations:
cookieAuthbearerAuth
path Parameters
id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /stream/{id}
A local JamServe API
http://localhost:4040/api/v1/stream/{id}

waveformController.waveform

get peaks waveform data as svg | json | binary

Authorizations:
cookieAuthbearerAuth
path Parameters
format
required
string
Default: "svg"
Enum:"dat" "json" "svg"

format of waveform data

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /waveform/{id}.{format}
A local JamServe API
http://localhost:4040/api/v1/waveform/{id}.{format}

Response samples

image/svg+xml
No sample

download

downloadController.download

download object as binary archive by id

Authorizations:
cookieAuthbearerAuth
path Parameters
id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /download/{id}
A local JamServe API
http://localhost:4040/api/v1/download/{id}

downloadController.download

download object as binary archive by id

Authorizations:
cookieAuthbearerAuth
path Parameters
format
required
string
Default: "zip"
Enum:"tar" "zip"

format of download stream

id
required
string

the item id

Responses

200

binary data

400

parameter is missing or invalid

401

unauthorized

404

requested object not found

500

internal server error

get /download/{id}.{format}
A local JamServe API
http://localhost:4040/api/v1/download/{id}.{format}